<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>shark::QpSolutionProperties Struct Reference</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceshark.html">shark</a></li><li class="navelem"><a class="el" href="structshark_1_1_qp_solution_properties.html">QpSolutionProperties</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="structshark_1_1_qp_solution_properties-members.html">List of all members</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle"><div class="title">shark::QpSolutionProperties Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>properties of the solution of a quadratic program  
 <a href="structshark_1_1_qp_solution_properties.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_quadratic_program_8h_source.html">shark/Algorithms/QP/QuadraticProgram.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a43adbf4089a94cf2124fc28602600719" id="r_a43adbf4089a94cf2124fc28602600719"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structshark_1_1_qp_solution_properties.html#a43adbf4089a94cf2124fc28602600719">QpSolutionProperties</a> ()</td></tr>
<tr class="separator:a43adbf4089a94cf2124fc28602600719"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a754cf16ef14ec337a626ab31c11ac444" id="r_a754cf16ef14ec337a626ab31c11ac444"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structshark_1_1_qp_solution_properties.html#a754cf16ef14ec337a626ab31c11ac444">accuracy</a></td></tr>
<tr class="memdesc:a754cf16ef14ec337a626ab31c11ac444"><td class="mdescLeft">&#160;</td><td class="mdescRight">typically the maximal KKT violation  <br /></td></tr>
<tr class="separator:a754cf16ef14ec337a626ab31c11ac444"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1b7fb15931dfebb70364b0bf949fa15" id="r_aa1b7fb15931dfebb70364b0bf949fa15"><td class="memItemLeft" align="right" valign="top">unsigned long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structshark_1_1_qp_solution_properties.html#aa1b7fb15931dfebb70364b0bf949fa15">iterations</a></td></tr>
<tr class="memdesc:aa1b7fb15931dfebb70364b0bf949fa15"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of decomposition iterations  <br /></td></tr>
<tr class="separator:aa1b7fb15931dfebb70364b0bf949fa15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3b4e5dcba8e39ee858c6ea36c8879b3" id="r_aa3b4e5dcba8e39ee858c6ea36c8879b3"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structshark_1_1_qp_solution_properties.html#aa3b4e5dcba8e39ee858c6ea36c8879b3">value</a></td></tr>
<tr class="memdesc:aa3b4e5dcba8e39ee858c6ea36c8879b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">value of the objective function  <br /></td></tr>
<tr class="separator:aa3b4e5dcba8e39ee858c6ea36c8879b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a965ff3df7a7c9ae101b0b06e82921c91" id="r_a965ff3df7a7c9ae101b0b06e82921c91"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structshark_1_1_qp_solution_properties.html#a965ff3df7a7c9ae101b0b06e82921c91">seconds</a></td></tr>
<tr class="memdesc:a965ff3df7a7c9ae101b0b06e82921c91"><td class="mdescLeft">&#160;</td><td class="mdescRight">training time  <br /></td></tr>
<tr class="separator:a965ff3df7a7c9ae101b0b06e82921c91"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>properties of the solution of a quadratic program </p>
<dl class="section user"><dt></dt><dd>The <a class="el" href="structshark_1_1_qp_solution_properties.html" title="properties of the solution of a quadratic program">QpSolutionProperties</a> structure collects statistics about the approximate solutions found in a solver run. It reports the reason for the iterative solver to stop, which was set according to the <a class="el" href="structshark_1_1_qp_stopping_condition.html" title="stopping conditions for quadratic programming">QpStoppingCondition</a> structure. Furthermore it reports the solution accuracy, the number of iterations, time elapsed, and the value of the objective function in the reported solution. </dd></dl>

<p class="definition">Definition at line <a class="el" href="_quadratic_program_8h_source.html#l00133">133</a> of file <a class="el" href="_quadratic_program_8h_source.html">QuadraticProgram.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a43adbf4089a94cf2124fc28602600719" name="a43adbf4089a94cf2124fc28602600719"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43adbf4089a94cf2124fc28602600719">&#9670;&#160;</a></span>QpSolutionProperties()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">shark::QpSolutionProperties::QpSolutionProperties </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_quadratic_program_8h_source.html#l00135">135</a> of file <a class="el" href="_quadratic_program_8h_source.html">QuadraticProgram.h</a>.</p>

<p class="reference">References <a class="el" href="structshark_1_1_qp_solution_properties.html#a754cf16ef14ec337a626ab31c11ac444">accuracy</a>, <a class="el" href="structshark_1_1_qp_solution_properties.html#aa1b7fb15931dfebb70364b0bf949fa15">iterations</a>, <a class="el" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540ab544fb3e76bdbaf78448f2416367ccc7">shark::QpNone</a>, <a class="el" href="structshark_1_1_qp_solution_properties.html#a965ff3df7a7c9ae101b0b06e82921c91">seconds</a>, and <a class="el" href="structshark_1_1_qp_solution_properties.html#aa3b4e5dcba8e39ee858c6ea36c8879b3">value</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a754cf16ef14ec337a626ab31c11ac444" name="a754cf16ef14ec337a626ab31c11ac444"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a754cf16ef14ec337a626ab31c11ac444">&#9670;&#160;</a></span>accuracy</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double shark::QpSolutionProperties::accuracy</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>typically the maximal KKT violation </p>

<p class="definition">Definition at line <a class="el" href="_quadratic_program_8h_source.html#l00145">145</a> of file <a class="el" href="_quadratic_program_8h_source.html">QuadraticProgram.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="structshark_1_1_qp_solution_properties.html#a43adbf4089a94cf2124fc28602600719">QpSolutionProperties()</a>.</p>

</div>
</div>
<a id="aa1b7fb15931dfebb70364b0bf949fa15" name="aa1b7fb15931dfebb70364b0bf949fa15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1b7fb15931dfebb70364b0bf949fa15">&#9670;&#160;</a></span>iterations</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned long long shark::QpSolutionProperties::iterations</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>number of decomposition iterations </p>

<p class="definition">Definition at line <a class="el" href="_quadratic_program_8h_source.html#l00146">146</a> of file <a class="el" href="_quadratic_program_8h_source.html">QuadraticProgram.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="_mc_svm_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>, <a class="el" href="_c_svm_linear_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main()</a>, <a class="el" href="structshark_1_1_qp_solution_properties.html#a43adbf4089a94cf2124fc28602600719">QpSolutionProperties()</a>, <a class="el" href="classshark_1_1_bias_solver.html#a94431a20658c032890cbb34fa0e0cba0">shark::BiasSolver&lt; Matrix &gt;::solve()</a>, and <a class="el" href="classshark_1_1_bias_solver_simplex.html#a60479f4edcd9038d612da5c34d4e6022">shark::BiasSolverSimplex&lt; Matrix &gt;::solve()</a>.</p>

</div>
</div>
<a id="a965ff3df7a7c9ae101b0b06e82921c91" name="a965ff3df7a7c9ae101b0b06e82921c91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a965ff3df7a7c9ae101b0b06e82921c91">&#9670;&#160;</a></span>seconds</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double shark::QpSolutionProperties::seconds</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>training time </p>

<p class="definition">Definition at line <a class="el" href="_quadratic_program_8h_source.html#l00148">148</a> of file <a class="el" href="_quadratic_program_8h_source.html">QuadraticProgram.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="_mc_svm_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>, <a class="el" href="_c_svm_linear_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main()</a>, and <a class="el" href="structshark_1_1_qp_solution_properties.html#a43adbf4089a94cf2124fc28602600719">QpSolutionProperties()</a>.</p>

</div>
</div>
<a id="aa3b4e5dcba8e39ee858c6ea36c8879b3" name="aa3b4e5dcba8e39ee858c6ea36c8879b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3b4e5dcba8e39ee858c6ea36c8879b3">&#9670;&#160;</a></span>value</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double shark::QpSolutionProperties::value</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>value of the objective function </p>

<p class="definition">Definition at line <a class="el" href="_quadratic_program_8h_source.html#l00147">147</a> of file <a class="el" href="_quadratic_program_8h_source.html">QuadraticProgram.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="classshark_1_1_radius_margin_quotient.html#a72f6cfe0cc96c2f1551861af80323f47">shark::RadiusMarginQuotient&lt; InputType, CacheType &gt;::computeRadiusMargin()</a>, <a class="el" href="_c_svm_linear_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main()</a>, and <a class="el" href="structshark_1_1_qp_solution_properties.html#a43adbf4089a94cf2124fc28602600719">QpSolutionProperties()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/shark/Algorithms/QP/<a class="el" href="_quadratic_program_8h_source.html">QuadraticProgram.h</a></li>
</ul>
</div><!-- contents -->
</div>
</body>
</html>
